home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / dirut / snif134.zip / SNIF.DOC < prev    next >
Text File  |  1992-03-16  |  19KB  |  457 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                       ---------------------------------
  9.                        SNiF - The ultimate file-finder
  10.                                  Version 1.34
  11.                                Copyright (c)1992
  12.                            Written by Carl Declerck
  13.                       ----------------------------------
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24. Introduction
  25. ------------
  26.  
  27. SNiF is a program that allows you to find files across one or more harddisks
  28. (floppies). It is operated from the DOS command line and offers many options
  29. which may affect the 'sniffing' (searching) of files.
  30.  
  31. SNiF uses a method called Dynamic Parameter Parsing (DPP) to give the user
  32. optimum sniffing performance. This means that options may be dynamically set
  33. from command-parameter to command-parameter, thus affecting only those actual
  34. parameters in between!
  35.  
  36. You will find that SNiF adapts itself automagically to your personal knowledge
  37. and experience in using the program. SNiF is as easy to operate as the DOS
  38. "dir" command. On the other hand, it is so powerful and versatile that a BBS
  39. sysop can do his complete daily maintenance under SNiF's control and
  40. supervision. Its uses and possibilities are unlimited!
  41.  
  42.  
  43. Running SNiF
  44. ------------
  45.  
  46. To start SNiF, you just type its name at the DOS prompt. When no parameters or
  47. options are given, SNiF will display some cryptic information on the options
  48. provided and their default values.
  49. The parameters which can be passed to SNiF are file-masks and options. File-
  50. masks are strings such as: *.BBS, BIMOD???.DOC, WIN.*, etc... any valid DOS
  51. wildcarded name. Options are strings such as: +d, -f, "+xdir &p&m", etc...
  52.  
  53.  
  54. Options provided
  55. ----------------
  56.  
  57.     +aHSRA, -a
  58.  
  59.     Allows you to specify an attribute mask. Only files that have these attrs
  60.     will be sniffed. Option -a disables attribute sniffing, it has the same
  61.     effect as +aHSRA (ie. all attrs on). Valid attribute-identifiers are:
  62.     H (Hidden), S (System), R (Read-only) and A (Archive). Any of these
  63.     identifiers may be combined to make up the sniffing attribute mask. The
  64.     order is of no importance.
  65.     The default is -a.
  66.  
  67.     +bSTRING, -b
  68.  
  69.     This option is only useful when using a logfile (see further). It allows
  70.     you to put in a commentline with the value of STRING. Note that when the
  71.     +b option is set, all logged pathnames of files sniffed will be indented
  72.     by 3 spaces, giving a neater layout. Option -b disables this indentation.
  73.     Note that when STRING equals "INFO", additional file-info will be logged
  74.     with each pathname.
  75.     The default is -b.
  76.  
  77.     +c, +c1, -c
  78.  
  79.     Tells SNiF to ask for confirmations before executing a given command, or
  80.     not. When just +c is used, SNiF will ask the user whether it should 
  81.     execute the specified +x command. Alternatively, when +c1 is used, SNiF
  82.     displays the currently found file and prompts for a command to be entered.
  83.     This command is subject to substitution just like the +xSTRING commands.
  84.     The default is -c.
  85.  
  86.     +d, -d
  87.  
  88.     This option allows you to tell SNiF whether it should display the full
  89.     pathname of any file that matches the given file-mask(s), or not.
  90.     The default is +d.
  91.  
  92.     +e, -e
  93.  
  94.     Enables or disables the escape key whilst sniffing.
  95.     The default is +e.
  96.  
  97.     +f, +f1, -f
  98.  
  99.     This option allows you to tell SNiF whether it should stop searching through
  100.     the directories when a file matching the specified file-mask(s) is found.
  101.     The +f option tells SNiF it should skip to the next directory when a
  102.     matching file is found, the +f1 option tells SNiF it should stop sniffing
  103.     immediately. The -f option tells SNiF it should just continue sniffing when
  104.     matching files are found.
  105.     The default is -f.
  106.  
  107.     +gSTRING, -g
  108.  
  109.     Allows you to snif for files that contain the STRING sequence of
  110.     characters. This option is cumulative, this means you can specify multiple
  111.     search-strings with multiple instances of +g.
  112.     By default, searching for a STRING is case-insensitive. To make it case-
  113.     sensitive, you precede STRING by a '!'. It is also possible to insert
  114.     non-keyboard characters by giving their ASCII value in 2-digit hex-from,
  115.     preceded by a backslash (ie. \XX). To escape the backslash itself, you
  116.     simply use '\\'.
  117.     Option -g clears ALL search-strings.
  118.     The default is -g.
  119.  
  120.     +iSTRING, -i
  121.  
  122.     Tells SNiF to take subsequent options from a control file. STRING is the
  123.     name of the control file to be used, it defaults to SNIF.CTL. When a +i
  124.     option is issued SNiF will open the control file and use its contents as
  125.     if they were passed as parameters on the command-line. When SNiF reaches
  126.     the end of the control file, it just continues taking its parameters from
  127.     the real command-line! This option is particularly useful for passing on
  128.     variable lists of filemasks that should be sniffed for. The -i option may
  129.     be used inside a control file to stop SNiF taking options from it.
  130.     The default is -i.
  131.  
  132.     +kSTRING, -k
  133.  
  134.     This one allows you to specify a 'C-like' format-string for the logfile
  135.     output. For each file sniffed this string will be logged, subject to the
  136.     following substitutions:
  137.  
  138.      &f  full pathname (incl. filename) of the file sniffed
  139.      &p  pathname only of file sniffed
  140.      &n  filename only of file sniffed
  141.      &m  currently active filemask
  142.      &t  sniffed file's creation time
  143.      &d  sniffed file's creation date
  144.      &a  sniffed file's attributes
  145.      &s  sniffed file's size in bytes
  146.  
  147.     It is also allowed to include hex-entries (\XX) in the format-string, like-
  148.     wise to the +g option.
  149.     The +k option is one of the more advanced features of SNiF... so for normal,
  150.     standard logfile-info one might rather use the simpler +bINFO (or -bINFO)
  151.     option! Option -k disables the format-string.
  152.     The default is -k.
  153.  
  154.     +lSTRING, -l
  155.  
  156.     Tells SNiF whether it should log the full pathname of each matching file,
  157.     or not. STRING is the name of the logfile to be used, if it doesn't exist,
  158.     it is created, if it exists already, it is appended to. When the +l option
  159.     is used with STRING omitted, STRING defaults to SNIF.LOG. However, if a
  160.     +lSTRING option has been turned off with -l, and is later re-activited with
  161.     just +l, the old value of STRING will be re-used!
  162.     The default is -l.
  163.  
  164.     +m, +m1, +m2, -m
  165.  
  166.     This option is an _extremely_ powerful one; it allows you to build advanced
  167.     exceptions using any criteria that SNiF supports (ie. not only filemasks,
  168.     as +n option). Advanced exceptions are built just as you would build a set
  169.     of criteria for normal sniffing, ie. you just specify the criteria which
  170.     make up the advanced exception using the normal options...
  171.     To start building advanced exceptions, issue the +m command. Any criteria
  172.     or filemasks following this +m will be added to the advanced exception
  173.     list.
  174.     When the advanced exception list is built, and you want to activate it,
  175.     issue the +m1 command and subsequently specify the criteria and filemasks
  176.     you wish to snif for.
  177.     For example: we wish to snif all files on the current drive, except all
  178.     hidden .SYS files. This could be done with something like:
  179.  
  180.       SNiF +m +aH *.sys +m1 -a *.*
  181.  
  182.     We first turn on advanced exception building with +m, then specify the
  183.     criterion for hidden-attribute sniffing and the *.sys filemask. Note that
  184.     after having turned off building of advanced exceptions with +m1 (thus also
  185.     activating it!), we still need to specify -a because we want to snif every
  186.     file on the drive, not only the hidden ones! It is important to note that a
  187.     +m1 instance does NOT turn off any criteria activated for advanced
  188.     exceptions, we must do so separately!
  189.     The +m2 option is similar to +m1, except that it also sets the Hidden
  190.     attribute of all files in the advanced exception list. This may be useful
  191.     when calling programs/commands that are passed wildcard parameters.
  192.     When SNiF terminates o